pp108 : Installing or Upgrading an Application (Deprecated)

Installing or Upgrading an Application (Deprecated)
This topic describes the procedure to install or upgrade an Application.

Note: Creating packages in ISVP format has been deprecated. All the content packaged from now on will be based on Process Platform Application Package (.cap) format. However, the applications packaged as an ISV are still allowed to be installed in order to support backward compatibility.

Before you begin this task
Installing an Application is an important activity. Therefore, it has strict pre-requisites that ensure a smooth installation. Ensure that you adhere to the following requirements before beginning installing an application.

  • You must have the role of systemAdmin to install or upgrade an application.
  • The System Organization must be your default organization to install or upgrade an application.
  • Before upgrading an application, it is recommended to take a backup of the LDAP content, database, and the filesystem related to the application, manually.
  • To install an application with system environment variables, DLL registration, or virtual folder creation as content on a windows based machine, you must change the access rights. For more information, refer to Installing an Application With System Environment Variables Content.
  • If the application you are installing contains run-time references to documents from another application, ensure that the other application is installed and the referenced documents are available.
    Note: If you have a Case model or an Organization model in your project, you need to package the individual dependent projects that each of these models create, such as Default Case Management Event Types and Default Organization Unit Types. They automatically do not appear in your current solution but will be available in the Projects list in the Workspace, to be added to the current solution. Without these dependent projects, you cannot install the main project containing these models. To make the dependent projects available at run time, make the project contents available in your main project and package them together for use at run time. However, you will need to repeat this activity of copying the dependent content, each time you create a new project.
  • Ensure that the version of the application you are installing is the same as the version of the run-time reference. A version mismatch will result in installation failure.
  • Ensure to install an application that is signed by a valid certificate.

Application provided by an Independent Software Vendor can be installed on Process Platform and used for application development. These Applications can be installed by a systemAdmin using the Application Registry. All the Applications to be installed must be placed at <Process_Platform_Installation_Directory>/isvcontent/packages.
Many features and functions are improved and added to the product on a regular basis. These enhancements are bundled in an application, in the form of relevant artifacts such as files, Web service operations, Web service interfaces, and XMLStore content. Upgrading the existing application to the latest version helps the user update the Process Platform environment with these upgraded features.
Upgrading an application refers to uninstalling the existing (older) version application and installing the latest application. An application is displayed for upgrade only when its build or version number is greater than its existing version.
You can view the status of the applications before installing or upgrading them.

  1. On CUSP > My Applications, click (Application Registry). The Application Registry - Installed Applications page appears and displays the installed applications.
  2. Click on the toolbar. The Application Registry - Install/Upgrade Applications page is displayed with a list of applications that can be installed or upgraded on different computers.

    Note: In this page, you will find the below options:

    • Templates - Lists the installation templates.
    • Applications - Lists the applications and related versions.
  3. Select a template or an application.

    Tip: To search for templates or applications, type a keyword in the Search text field.

  4. Select the computer(s) to install the applications from the Systems list.
  5. Click Start button to start installing or upgrading the selected applications. The Application Installer wizard appears and displays the Selected Machines and Application screen. This screen displays the selected computers and applications which are classified as :
    • Applications that can be installed
    • Application that can be upgraded
      Note: Dependent applications that must be installed along with the selected applications, are also displayed in the Applications section.
  6. Click the Nextbutton. Depending on the applications being installed or upgraded, the following pages appear:

    If

    then

    Details

    One or more applications are to be upgraded.

    The Delete the references of Upgradable Applications screen appears.

    Select the checkboxes against the Applications, to delete the references of the associated Roles and Web service interfaces packaged in that Application.

    The applications to be installed or upgraded are invalid.

    The Applications Signature Verification Status screen appears.

    This page lists the selected applications in a tree structure. You can expand each application to view the dependent applications.
    Note: Installer verifies the application being installed and determines its authorization and validity. For more information, refer to Application Verification Scenarios. To install an application that is any of the following types, you can change its security settings and continue to install.
    * Tampered
    * Unsigned
    * Signed with an untrusted certificate
    * Signed with a certificate with improper key usage
    CAUTION: In case of the aforesaid applications, it is strictly recommended not to proceed with installation as there are high chances of data corruption.

    The applications to be installed or upgraded are enabled for End User License Agreement (EULA) approval during its creation.

    The Legal Information screen appears.

    This legal information will provide details regarding License agreement for using the artifacts provided by respective application and must be read carefully before proceeding for loading. Click the Accept button to continue with the installation.

    The applications to be installed must configure database details.

    The Provide required inputs screen appears.

    Provide the necessary details for the Database Configuration of Applications.
  7. Click the Next button. The Start Installing/Upgrading the Applicationspage appears, listing the applications to be installed or upgraded.

    Note:

    • To specify how long an application can take to install, define the time period (in minutes) in the Time Out textbox. The default value is three minutes.
    • To record the complete web-based application installation inputs to a file and reuse the file for an installation in another computer, select Save the Available Applications as a template check box and type a filename. The generated input file is saved in the Process Platform Repository, with /Cordys/WCP/Installation Templates/default/<File name> key. Retrieve this key for silent installation. This check box is optional. However, you may select it to install the applications in silent mode, that is, to install the applications without any interface.
  8. Click Install/Upgrade to start installing or upgrading the application.
    Note: Ensure to verify whether all the selected applications are displayed in the list. The status of installation or upgrade is indicated on the same page.
  9. Click Finish to complete the process and exit the Application Installerwizard.

    Tip: You can upload an application from your computer and then install or upgrade it. For more information refer to Uploading an Application.

    The selected applications are installed or upgraded.

    Note:

    • Applications with COM DLL content can only be installed on a Windows based computer.
    • On a Linux based computer, when an application with system environment variables content is installed, the <Process_Platform_Installation_Directory>/bin/wcpenv.sh file is updated.
    • The application log file, created in the Process Platform Installation directory, must not be deleted, moved, or modified in order to avoid improper uninstalling of application.
    • If an application being installed contains Virtual Directories, the Application Installer overwrites the existing directories on IIS web server. This is not applicable to Apache web server.
    • If an application contains web applications or htm files andis installed on a distributed environment, these applications will not work if a Primary Machine Gateway is used to access them.
    • If an application is created or named in Multi-byte characters such as Chinese, Japanese, German, or Korean languages, the Application Installer fails to install these packages, as JVM cannot install these files to memory.
    • The classpath for System Environment Variables (which are bundled along with an application) is placed in the BCP classpath file. This file is located at <Process_Platform_Installation_Directory>/ Config and is referred during application installation to load the classes dynamically.
    • While loading an application, the application Framework will search for the Custom Loader class at System Classpath and BCP Classpath. If the Custom Loader class is available in System Classpath, the framework will not lookup BCP Classpath. The dependent jars of the Custom Loader class must also be available in the System Classpath.
      If you have MDM models packed in Cordys C3 version, after deploying the model in BOP 4.1, ensure that the JRE classpath of MDM service, Hub Publisher, and Spoke Publisher service containers is correct.
    • If the installation of an Application fails, do the following:
    1. Access Management Console
    2. Add the property, com.cordys.isv.log.level and set the value as 'info' or 'error' or 'fatal' (by default the value is debug).
    3. Restart the Monitor and retry the installation.
    • The Staging Application is not supported for upgrading procedure. Applications that cannot be upgraded appear disabled in the Application Registry - Upgrade Applications page. To know the details, click in the Status column and the reason appears in the Status Message box.